// Pipeline Component Library Example
// ----------------------------------
// Colin Bowern (colinbowern@hotmail.com)
// January 2007
//
// Copyright (c) 2007 Colin Bowern
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// * The above copyright notice and this permission notice shall be included in
//   all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#region References
using Microsoft.CommerceServer.Runtime;
using Microsoft.CommerceServer.Orders;
using System;
using System.Diagnostics;
#endregion

namespace RockstarGuys.PipelineComponents
{
    /// <summary>
    /// Represents the results of the PromoCode Pipeline Components execution.
    /// </summary>
    /// <remarks>
    /// For more information see http://msdn2.microsoft.com/en-us/library/microsoft.commerceserver.runtime.orders.promocoderecord.aspx
    /// </remarks>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1035:ICollectionImplementationsHaveStronglyTypedMembers"), DebuggerDisplay("PromoCode = {PromoCode}")]
    public class PromoCodeRecord : Dictionary
    {
        #region Properties
        /// <remarks />
        public string PromoCode
        {
            get { return this[PromoCodeRecord.KeyNames.PromoCode] as string; }
            set { this[PromoCodeRecord.KeyNames.PromoCode] = value; }
        }

        /// <remarks />
        public int PromoCodeDefinitionId
        {
            get { return GetValue<int>(PromoCodeRecord.KeyNames.PromoCodeDefinitionId); }
            set { this[PromoCodeRecord.KeyNames.PromoCodeDefinitionId] = value; }
        }

        /// <remarks />
        public DateTime PromoCodeLookupDate
        {
            get { return GetValue<DateTime>(PromoCodeRecord.KeyNames.PromoCodeLookupDate); }
            set { this[PromoCodeRecord.KeyNames.PromoCodeLookupDate] = value; }
        }

        /// <remarks />
        public PromoCodeState PromoCodeStatus
        {
            get { return (PromoCodeState)Enum.Parse(typeof(PromoCodeState), this[PromoCodeRecord.KeyNames.PromoCodeStatus] as string, true); }
            set { this[PromoCodeRecord.KeyNames.PromoCodeStatus] = value.ToString(); }
        }

        /// <remarks />
        public bool PromoApplied
        {
            get { return GetValue<bool>(PromoCodeRecord.KeyNames.PromoApplied); }
            set { this[PromoCodeRecord.KeyNames.PromoApplied] = value; }
        }

        /// <remarks />
        public bool PromoCodeReserved
        {
            get { return GetValue<bool>(PromoCodeRecord.KeyNames.PromoCodeReserved); }
            set { this[PromoCodeRecord.KeyNames.PromoCodeReserved] = value; }
        }
        #endregion

        #region Constructor
        /// <summary>
        /// Initializes a new instance of the <see cref="PromoCodeRecord"/> class.
        /// </summary>
        /// <remarks>
        /// The underlying store can be persisted through referencing the InnerDictionary property.
        /// </remarks>
        public PromoCodeRecord() : base()
        {
            this.PromoCode = "";
            this.PromoCodeDefinitionId = 0;
            this.PromoCodeLookupDate = default(DateTime);
            this.PromoCodeStatus = default(PromoCodeState);
            this.PromoApplied = default(bool);
            this.PromoCodeReserved = default(bool);
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PromoCodeRecord"/> class.
        /// </summary>
        /// <param name="container">The container.</param>
        [CLSCompliant(false)]
        public PromoCodeRecord(IDictionary container) : base(container) { }
        #endregion

        #region Nested Types
        /// <summary>
        /// Keys used to access the properties in the dictionary.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1815:OverrideEqualsAndOperatorEqualsOnValueTypes"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible")]
        public struct KeyNames
        {
            /// <remarks />
            public const string PromoCode = "promo_code";
            /// <remarks />
            public const string PromoCodeDefinitionId = "promo_code_definition_id";
            /// <remarks />
            public const string PromoCodeLookupDate = "dt_promo_code_lookup";
            /// <remarks />
            public const string PromoCodeStatus = "promo_code_status";
            /// <remarks />
            public const string PromoApplied = "promo_applied";
            /// <remarks />
            public const string PromoCodeReserved = "promo_code_reserved";
        }
        #endregion
    }
}